XIQS Create Price Plan

Create a new Price Plan object for current partition

String name (named)

Price Plan Name

[String id_partition] (named)

Partition Id

[String id_operator] (named)

GSM Network Operator PLMN (MCC+MNC) code

[String paytype] (named)

Sim Type:
0 - Prepaid
3 - Postpaid

[String defaultplan] (named)

Set this Price Plan as Default Price Plan

[String slidctrl] (named)

SLID Management Support flag

[String maxrollover] (named)

Postpaid Roll Over Minutes (months)

[String alertstep] (named)

Call threshold limit alers (%)

[String smsalertstep] (named)

SMS threshold limit alert (%)

[String callconfee] (named)

Call Processing Credit Time (seconds); Call connection fee

[String mincallcharge] (named)

Call Connection Credit Time (seconds); Minimal Call billing period

[String stepcallcharge] (named)

Call Step Credit Time (seconds); Call billing increment

[String birthday] (named)

Postpaid Calendar Day (1-31); Indicate on which day of the month that SIM cards of the given price plan get new inclusive minutes

[String smsinterdelay] (named)

Inter SMS Delay (seconds)

[String callinterdelay] (named)

Inter Call Delay (seconds)

[String randinterdelay] (named)

Random parameter for Call/SMS delay (%)

[String id_hbs] (named)

HBS Scenario Id

[String cp_inclusivsec] (named)

Call Credit Peak Initial Credit (seconds)

[String cp_allowoverplan] (named)

Call Credit Peak Allow Over Plan flag

[String cp_allowcrossnet] (named)

Call Credit Peak Allow CrossNet flag

[String cop_inclusivsec] (named)

Call Credit Off Peak Initial Credit (seconds)

[String cop_allowoverplan] (named)

Call Credit Off Peak Allow Over Plan flag

[String cop_allowcrossnet] (named)

Call Credit Off Peak Allow CrossNet flag

[String cb_inclusivsec] (named)

Call Credit Bonus Initial Credit (seconds)

[String cb_allowoverplan] (named)

Call Credit Bonus Allow Over Plan flag

[String cb_allowcrossnet] (named)

Call Credit Bonus Allow CrossNet flag

[String sp_inclusivnb] (named)

SMS Credit Peak Initial Credit

[String sp_allowoverplan] (named)

SMS Credit Peak Allow Over Plan flag

[String sp_allowcrossnet] (named)

SMS Credit Peak Allow CrossNet flag

[String sop_inclusivnb] (named)

SMS Credit Off Peak Initial Credit

[String sop_allowoverplan] (named)

SMS Credit Off Peak Allow Over Plan flag

[String sop_allowcrossnet] (named)

SMS Credit Off Peak Allow CrossNet flag

[String sb_inclusivnb] (named)

SMS Credit Bonus Initial Credit

[String sb_allowoverplan] (named)

SMS Credit Bonus Allow Over Plan flag

[String sb_allowcrossnet] (named)

SMS Credit Bonus Allow CrossNet flag

String ussdcommand (named)

Depending on the method of Credit Check (USSD, SMS or USSD with SMS answer) it could be:
- USSD Script Command (for example "*121#")
- SMS Message, prefixed by SMS Server Number (for example "SMS+33100,SMS credit check")
- USSD Script Command waiting for response sent in SMS message (for example "USM*222#")

String ussdtrigger (named)

Credit Check Trigger (1-Manual, 2-Sim Release, 3-Remaining minutes, 4-Sim Registration, 5-Daily Sim Registration)

String smsussdtrigger (named)

Credit Check via (1-USSD, 2-SMS, 3-USSD with SMS answer)

String ussdsync (named)

Credit Synchronization type (1-Automatic, 2-Manual)

[String checkondeactivate] (named)

Check Credit at Sim Deactivation

[String advantage0] (named)

Maximal gap allowed (%)

[String advantage1] (named)

Maximal gap allowed (minutes)

[String ussdnoportrestart] (named)

Restart Port Before Credit Check

[String additionalsms] (named)

Number of additional SMS that will be received

[String addsmsrequired] (named)

Mandatory additional SMS flag

[String ussdmatch] (named)

Message Returned for Valid USSD/SMS; Specify the template that describes the USSD/SMS string sent by the operator. The goal of the string format is to identify several variables into the USSD/SMS string.
'*' - Star can be used to bypass several characters, until the characters that follow the star was found.
'$' - Dollar sign is used to identify a part of the USSD string in which the variables can be found. A zone that contains variables is enclosed into two characters $.
'#i' - variable; 10 integer variables can be defined: #1, #2, #3, #4, #5, #6, #7, #8, #9, #10.
'<>' - Each variable definition is enclosed into a starting < and ending >.
'=' - Variable assignment as follow #i= ‘Expression’
‘Expression’ is a string that contain * to identify the variable value and some characters that specify where to find the values.
For example *hh specify that the value of the variable is the integer value that is just before text "hh".
If expression is not found then the variable value is 0.
Example: *credit is $<#1=*h><#2=*m><#3=*s>$                                                                                                            

[String ussdmatch2] (named)

Message Returned for Valid 2nd SMS; The same format as for 'ussdmatch'

[String ussdpeak] (named)

Specify how to compute Call Credit Peak (in seconds) from the variables; Enter an expression that use the variables (#1, #2, #3, #4, #5, #6, #7, #8, #9, #10) and operators ( + - * / ). Expression value is rounded to integer.
Example: #1 * 3600 + #2 * 60 + #3

[String ussdoffpeak] (named)

Specify how to compute Call Credit Off Peak (in seconds) from the variables; Format is the same as for the previous parameter

[String bonus] (named)

Specify how to compute Call Credit Bonus (in seconds) from the variables; Format is the same as for the previous parameter

[String smspeak] (named)

Specify how to compute SMS Credit Peak; Format is the same as for the previous parameter

[String smsoffpeak] (named)

Specify how to compute SMS Credit Off Peak; Format is the same as for the previous parameter

[String smsbonus] (named)

Specify how to compute SMS Credit Bonus; Format is the same as for the previous parameter

[String ussdstring] (named)

Valid sample of USSD/SMS returned message

[String ussdstring2] (named)

Valid sample of 2nd SMS returned message

[String nocreditfmt] (named)

Message Returned if out of credit

[String notnetfmt] (named)

Message Returned on Network failure

[String ussdresponse] (named)

The last received USSD/SMS message

[String ussdresponse2] (named)

The last received 2nd SMS message

[String topmode] (named)

Recharge mode:
0 - Manual
1 - Automatic
2 - By Allocation Rule

[String topmethod] (named)

Recharge SIM vie:
0 - IVR
1 - SMS
2 - USSD

[String topsmswait] (named)

Requirement for last SMS:
0 - None
1 - Notification
2 - SMS Replay

[String id_transferplan] (named)

Transfer Plan Id

[String topfor] (named)

Recharge SIM for:
0 - Call
1 - SMS
2 - Call & SMS

[String remainsec] (named)

Recharge SIM on remaining call credit

[String remainsmsnb] (named)

Recharge SIM on remaining SMS number

[String topnum] (named)

Recharge IVR/SMS Server number / USSD Script Command

[String topscript] (named)

Recharge IVR Script / SMS Message

[String ackivrnum] (named)

Confirmation IVR/SMS Server number / Supplementary USSD Script for Confirmation

[String ackivrscript] (named)

IVR Scritp/SMS message for Confirmation

[String topactivsim] (named)

Reactive SIM after recharge flag

[String topchkcredit] (named)

Check credit after recharge flag

[String activmode] (named)

Activation mode:
0 - Manual
1 - Automatic
2 - By Allocation Rule

[String activaction] (named)

Activation action:
0 - Sim card
1 - Promotion

[String activchkcredit] (named)

For Activation action Promotion, Check credit after activation flag

[String activpromoscript] (named)

For Activation action Promotion, Promotion Scheduler script

[String activmethod] (named)

Activation method:
0 - IVR
1 - SMS
2 - USSD

[String activsmswait] (named)

For Activation method SMS, Requirement for Last SMS:
0 - None
1 - Notification
2 - SMS Replay

[String activnum] (named)

Depending on Activation method:
- Activation number for IVR and SMS
- Activation USSD command for USSD
Can contain any of the following characters '1'..'9' '*' '#' '+', but also "%n" to specify simcard called number and ',' to separate USSD menu choices

[String activscript] (named)

Activation script for IVR and SMS Activation methods, depending on Activation method it can contain:
- For IVR any of the following characters '1'..'9' '*' '#' '+', but also "%n" to specify simcard called number, '.' meaning pause of 1 sec and ';' meaning pause of 5 sec 
- For SMS any text, "%n" to specify simcard called number

[String daymaxcalltime] (named)

Maximal daily Time on call (seconds)

[String daymaxcallmode] (named)

Maximal daily Time on call type:
0 - Billing time
1 - Real time

[String daymaxcallnb] (named)

Maximal daily number of Call Attempts

[String daymincalltime] (named)

Minimal daily Call Duration to Consider (seconds)

[String daymincallmode] (named)

Include non connected calls into Minimal daily Call Duration flag

[String daycallperiod] (named)

Call counter as per Block Time Period (seconds)

[String dayforcedisco] (named)

Force SIM deactivation call on limit reached

[String daymaxsms] (named)

Maximal daily number of sent SMS

[String daymaxsmserr] (named)

RESERVED FOR FUTURE USAGE

[String calldisablesim] (named)

Activate Call & False Answer Supervision flag                                                                                                            

[String callgeneric] (named)

Counter for Successve Non Connected Calls (0=OFF, take over any other cause)

[String callnodial] (named)

Counter for NO DIALTONE Cause handled from Network

[String callnocarrier] (named)

Counter for NO CARRIER Cause handled from Network

[String callcallerdisco] (named)

Counter for CALLER HANGUP Cause handled from Network

[String callbusy] (named)

Counter for CALL BUSY Cause handled from Network

[String callmsgonprogress] (named)

Counter for Provider Message Detection from SETUP

[String callmsgonring] (named)

Counter for Provider Message Detection from ALERTING

[String callmsgonconnect] (named)

Counter for Provider Message Detection from CONNECTION

[String callnoanswer] (named)

Counter for NO ANSWER Cause handled from Network

[String callunknownerr] (named)

Counter for Successive Unspecified Disconnection Cause (0=OFF)

[String smsdisablesim] (named)

Activate Successive SMS Disconnect Cause Counters flag (requires IRON Call Manager)

[String smsmaxerrnb] (named)

Counter for Successive SMS Unspecified Disconnection Cause

Error Data structure ( Error Management )

Possible failure code returns
 *ERR_CMD_SYNTAX (400) ERR_MSG_PPLAN_FD_ADDED or ERR_MSG_PPLAN_NO_FIELD
 *ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
                                                                                                            

getXIQSPricePlanList

updateXIQSPricePlan

getXIQSPPSettingsInfo

getXIQSPPTopupInfo

getXIQSPPCreditInfo

getXIQSPPCreditCheckInfo

deleteXIQSPricePlan

getXIQSUSSDCreditCheckString